DisplayPosition Property, SftTreeColumns Object


	SftTreeColumns.DisplayPosition Property	Softel vdm, Inc.

Returns the display position given a real column number.

Syntax

Get
	VB.NET	DispColIndex = object.DisplayPosition(ByVal ColIndex As Short) As Short
	VB	DispColIndex = object.DisplayPosition(ByVal ColIndex As Integer) As Integer
	C#.NET	short DispColIndex = object.get_DisplayPosition(short ColIndex);
	VC++	short DispColIndex = object->DisplayPosition[short ColIndex]; short DispColIndex = object->GetDisplayPosition(short ColIndex);
	C	HRESULT object->get_DisplayPosition(short ColIndex, short* DispColIndex);
	Delphi	DispColIndex := object.DisplayPosition[ColIndex : Smallint] : Smallint;

object

A SftTreeColumns object.

ColIndex

The zero-based column number.

DispColIndex

Returns the display position given a real column number.

Comments

The DisplayPosition property returns the display position given a real column number.

As a user reorders columns, this is completely transparent to the application. An application still references cells and columns by the "real" column number, which is the original column number that the cell or column had before columns were reordered by the user. While columns appear in a new order after dragging a column to a new position, the application references cells and columns by their real column number which never changes.

If a user reorders columns using column drag & drop, the (real) column numbers used by an application may need to be translated into the actual display column number, which is the column number as it appears to the user.

The ColumnsObj.Move method can be used to reorder columns under program control.